home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / c2man-2.0pl33.lha / c2man-2.0 / README < prev    next >
Encoding:
Text File  |  1995-01-24  |  4.3 KB  |  100 lines
  1.  
  2.                 c2man, Version 2
  3.                 by Graham Stoney
  4.  
  5.  Copyright (c) 1992, 1993, 1994 by Canon Information Systems Research Australia
  6.                   All rights reserved.
  7.  
  8. This is c2man, a program for generating Unix style manual pages in nroff/troff
  9. -man, TeXinfo, LaTeX or HTML format directly from ordinary comments embedded in
  10. C source code. It should run on virtually any Unix-like system, OS/2, VMS or
  11. MSDOS.
  12.  
  13. You will need lex or flex, plus yacc or bison, and a C compiler (traditional
  14. K&R 1 or ISO/ANSI will do) to build the program. You'll also need a text
  15. formatter to format its output.
  16.  
  17. This version of c2man is copyright, but may be freely redistributed and modified
  18. so long as:
  19.  
  20. 1. The names of all contributing authors remain on the documentation,
  21. 2. All derivative works are clearly documented as such,
  22. 3. All derivative works remain freely redistributable under the same conditions.
  23.  
  24. As such, there is no warranty.
  25.  
  26. c2man owes a huge debt to the public domain program cproto, by Chin Huang, from
  27. which much of the code is derived.
  28.  
  29. The manual page includes some automatically generated examples, which will be
  30. missing if you try to read it before doing a make.  Running make will generate
  31. the complete manual page, which you can then copy around freely.
  32.  
  33. c2man does not currently support C++, but if you think this would be worth
  34. while, look in the file C++autodoc for information on how I envisage C++
  35. support could be added, and get ready to volunteer.
  36.  
  37. By popular demand, there are a few trivial examples of different comment
  38. styles in the eg directory.  I'm open to submissions from users too.
  39.  
  40.  
  41. There is a mailing list for c2man users; it is very low volume and has a very
  42. low noise content.  This is the preferred place to ask questions about the
  43. program and discuss modifications and additions with the author and other
  44. users.  You are encouraged to join by sending mail with no Subject: line to
  45. <listserv@research.canon.oz.au> containing:
  46.  
  47.     SUBSCRIBE c2man Your name
  48.  
  49. Where `Your name' should be replaced with your real name.
  50. Messages for distribution to everyone on the list should be sent to:
  51. <c2man@research.canon.oz.au>.
  52.  
  53.  
  54. The time I have available for c2man support is rather limited, but if it lacks
  55. any features you require, feel free to Email me (preferably to the mailing list
  56. address above) asking about it.  Unless you request otherwise, I will probably
  57. cc: to the list replies to any questions that I get mailed, to save me
  58. answering them again for other people.  I encourage you to go ahead and make
  59. any changes you like and send me the diffs for inclusion in the next patch, but
  60. it's a good idea to ask first in case someone already has the feature you want
  61. in the works.  In order for me to integrate your changes, they need to be
  62. reasonably "clean", and you'll need to update manual page as appropriate.
  63.  
  64. Please try to remember to include the c2man version number in any bug reports.
  65. You can find it by running: c2man -V /dev/null
  66.  
  67. If you'd like to be notified automatically about new releases and patches,
  68. answer yes to the Configure question about sending mail to the author.
  69.  
  70.  
  71. Special thanks for their direct and indirect contributions to c2man go to:
  72.     Larry Wall, Raphael Manfredi and Harlan Stenn for writing various bits of
  73.     metaconfig, which generated the Configure script.
  74.  
  75.     Darrel Hankerson for the OS/2 and MSDOS ports.
  76.     Rick Flower for the VMS port.
  77.  
  78.     Richard Kooijman for the LaTeX backend, and for fixing the TeXinfo backend.
  79.     Diab Jerius too, for more work on the TeXinfo backend.
  80.     Frank P.J. Ooms for the HTML backend.
  81.  
  82.     Vern Paxson for his suggestions on how to handle comment lexing better.
  83.  
  84. Thanks to the following people for suggestions & bug fixes is long overdue:
  85.     Peter (P.) Barszczewski, Carlo Tarantola, Dennis Allison,
  86.     Philip Yzarn de Louraille, Jerry Lieberthal, Mats Ohrman, Stefan Zimmermann,
  87.     Dolf Grunbauer, Lele Gaifax, Carl R. Crawford, Jhon Honce, Chris Borchert,
  88.     Jerry E. Dunmire, Marty Leisner, Dan Forrest, Ken Weinert, Ken Poppleton.
  89.  
  90. (Hmmm.  This is beginning to sound like an Academy Awards night...)
  91.  
  92.  
  93. See the file INSTALL for Unix installation instructions.
  94. OS/2 and MSDOS users should see the README.pc file in the pc directory.
  95. VMS users should see the README.1st in the VMS directory.
  96.  
  97.  
  98. Graham Stoney                       greyham@research.canon.oz.au
  99. Mailing List for general c2man Questions & Answers   c2man@research.canon.oz.au
  100.